Kotools Types/kotools.types.collections/NotEmptyList

NotEmptyList

@SinceKotoolsTypes(version = "1.3")

class NotEmptyList<out E>(val head: E, tail: E) : AbstractList<E> , NotEmptyCollection<E>

Represents lists containing at least one element.

Parameters

E

The type of elements contained in this list.

Constructors

fun <out E> NotEmptyList(head: E, vararg tail: E)

Creates a not empty list starting with a head and containing all the elements of the optional tail.

Functions

open operator override fun contains(element: E): Boolean

open override fun containsAll(elements: Collection<E>): Boolean

open operator override fun equals(other: Any?): Boolean

open fun forEach(p0: Consumer<in E>)

open infix operator fun get(index: PositiveInt): E

open infix operator fun get(index: StrictlyPositiveInt): E

Returns the element at the specified index in this collection, or throws an IndexOutOfBoundsException if the index is out of bounds.

open infix operator override fun get(index: Int): E

Returns the element at the specified index in this collection, or throws an IndexOutOfBoundsException if the index is out of bounds.

open infix fun getOrNull(index: Int): E?

open infix fun getOrNull(index: PositiveInt): E?

open infix fun getOrNull(index: StrictlyPositiveInt): E?

Returns the element at the specified index in this collection, or returns null if the index is out of bounds.

open override fun hashCode(): Int

open override fun indexOf(element: E): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): Iterator<E>

open override fun lastIndexOf(element: E): Int

open override fun listIterator(): ListIterator<E>

open override fun listIterator(index: Int): ListIterator<E>

open fun parallelStream(): Stream<E>

open override fun spliterator(): Spliterator<E>

open fun stream(): Stream<E>

open override fun subList(fromIndex: Int, toIndex: Int): List<E>

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>

toNotBlankString

open fun toNotBlankString(): NotBlankString

Returns the string representation of this collection as a not blank string.

open override fun toString(): String

Properties

open override val head: E

First element of this collection.

open override val size: Int

open val typedSize: StrictlyPositiveInt

Returns the size of this collection as a strictly positive int.

Extensions

@SinceKotoolsTypes(version = "1.3")

inline fun <E> NotEmptyCollection<E>.getOrElse(index: Int, defaultValue: (Int) -> @UnsafeVariance E): E

@SinceKotoolsTypes(version = "1.3")

inline fun <E> NotEmptyCollection<E>.getOrElse(index: PositiveInt, defaultValue: (PositiveInt) -> @UnsafeVariance E): E

@SinceKotoolsTypes(version = "1.3")

inline fun <E> NotEmptyCollection<E>.getOrElse(index: StrictlyPositiveInt, defaultValue: (StrictlyPositiveInt) -> @UnsafeVariance E): E

Returns the element at the specified index in this collection, or returns the result of calling the defaultValue function if the index is out of bounds.

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptyList(): NotEmptyList<E>

Returns a not empty list containing all the elements of this collection, or throws an IllegalArgumentException if this collection is empty.

toNotEmptyListOrElse

@SinceKotoolsTypes(version = "1.3")

infix inline fun <E> Collection<E>.toNotEmptyListOrElse(defaultValue: (Collection<E>) -> NotEmptyList<E>): NotEmptyList<E>

Returns a not empty list containing all the elements of this collection, or returns the result of calling the defaultValue function if this collection is empty.

toNotEmptyListOrNull

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptyListOrNull(): NotEmptyList<E>?

Returns a not empty list containing all the elements of this collection, or returns null if this collection is empty.

toNotEmptyMutableList

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptyMutableList(): NotEmptyMutableList<E>

Returns a not empty mutable list containing all the elements of this collection, or throws an IllegalArgumentException if this collection is empty.

toNotEmptyMutableListOrElse

@SinceKotoolsTypes(version = "1.3")

infix inline fun <E> Collection<E>.toNotEmptyMutableListOrElse(defaultValue: (Collection<E>) -> NotEmptyMutableList<E>): NotEmptyMutableList<E>

Returns a not empty mutable list containing all the elements of this collection, or returns the result of calling the defaultValue function if this collection is empty.

toNotEmptyMutableListOrNull

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptyMutableListOrNull(): NotEmptyMutableList<E>?

Returns a not empty mutable list containing all the elements of this collection, or returns null if this collection is empty.

toNotEmptyMutableSet

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptyMutableSet(): NotEmptyMutableSet<E>

Returns a not empty mutable set containing all the elements of this collection, or throws an IllegalArgumentException if this collection is empty.

toNotEmptyMutableSetOrElse

@SinceKotoolsTypes(version = "1.3")

infix inline fun <E> Collection<E>.toNotEmptyMutableSetOrElse(defaultValue: (Collection<E>) -> NotEmptyMutableSet<E>): NotEmptyMutableSet<E>

Returns a not empty mutable set containing all the elements of this collection, or returns the result of calling the defaultValue function if this collection is empty.

toNotEmptyMutableSetOrNull

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptyMutableSetOrNull(): NotEmptyMutableSet<E>?

Returns a not empty mutable set containing all the elements of this collection, or returns null if this collection is empty.

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptySet(): NotEmptySet<E>

Returns a not empty set containing all the elements of this collection, or throws an IllegalArgumentException if this collection is empty.

toNotEmptySetOrElse

@SinceKotoolsTypes(version = "1.3")

infix inline fun <E> Collection<E>.toNotEmptySetOrElse(defaultValue: (Collection<E>) -> NotEmptySet<E>): NotEmptySet<E>

Returns a not empty set containing all the elements of this collection, or returns the result of calling the defaultValue function if this collection is empty.

toNotEmptySetOrNull

@SinceKotoolsTypes(version = "1.3")

inline fun <E> Collection<E>.toNotEmptySetOrNull(): NotEmptySet<E>?

Returns a not empty set containing all the elements of this collection, or returns null if this collection is empty.